Skip to content

Conversation

rtrieu
Copy link
Contributor

@rtrieu rtrieu commented Aug 1, 2025

What does this PR do? What is the motivation?

Adds a new page about how to auto-instrument RUM on java servlet-based web applications.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@rtrieu rtrieu requested review from a team as code owners August 1, 2025 21:05
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Aug 1, 2025
Copy link
Contributor

github-actions bot commented Aug 1, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Copy link
Contributor

github-actions bot commented Aug 1, 2025

Preview links (active after the build_preview check completes)

New or renamed files

@hestonhoffman hestonhoffman added the editorial review Waiting on a more in-depth review label Aug 1, 2025
@sarjyusuf sarjyusuf requested a review from PerfectSlayer August 4, 2025 14:04
Copy link
Contributor

@PerfectSlayer PerfectSlayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. Not an RUM eng but it's very similar to the manual I wrote for the customer preview.

Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, Rosa! For the content, I just have some minor suggestions and things I want to double-check 🙂

While I was clicking around on the page, I noticed that if I switched to another tab and tried to click back to Java, the tab wouldn't load. You can see that it assumed that the end of the URL was java instead of java_servlet:
image

I did some digging into our internal docs, and for multi-code-lang pages, it looks like the possibilities for tab names are limited. It looks like if you rename this new file from java_servlet.md to java.md, it should fix it, and you should still be able to keep Java Servlet as the page title. This all works on my local build, but if you have anything you'd like to troubleshoot together, don't hesitate to let me know!

If you don't see the RUM JavaScript tag injected, try the following steps:

1. **Check server logs** for any error messages related to RUM Auto-Instrumentation
2. **Verify configuration** - ensure all required environment variables are set:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where should users first learn about these variables? If they should be preset in another step, that's fine - just want to make sure that they don't first see them in a troubleshooting section.

Copy link
Contributor Author

@rtrieu rtrieu Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to the following, but let me know if you have better ideas

Suggested change
2. **Verify configuration** - ensure all required environment variables are set:
2. **Verify configuration** - ensure all required environment variables defined at the configuration step are set:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I wouldn't be sure which configuration step this would be referring to, because this guide doesn't include one?

@rtrieu
Copy link
Contributor Author

rtrieu commented Aug 11, 2025

Looks great, Rosa! For the content, I just have some minor suggestions and things I want to double-check 🙂

While I was clicking around on the page, I noticed that if I switched to another tab and tried to click back to Java, the tab wouldn't load. You can see that it assumed that the end of the URL was java instead of java_servlet: image

I did some digging into our internal docs, and for multi-code-lang pages, it looks like the possibilities for tab names are limited. It looks like if you rename this new file from java_servlet.md to java.md, it should fix it, and you should still be able to keep Java Servlet as the page title. This all works on my local build, but if you have anything you'd like to troubleshoot together, don't hesitate to let me know!

Thanks for noticing this! I updated the filename and it does seem to work fine now.

@rtrieu rtrieu requested a review from janine-c August 11, 2025 18:13
@janine-c
Copy link
Contributor

Thanks for noticing this! I updated the filename and it does seem to work fine now.

Awesome! Do you need to push this change? I'm still seeing the old filename 🙂

Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, Rosa! I see what you mean now about your wording suggestion about the "configuration step" now 🙂 Just one line that snuck in there to take out in addition to that updated wording, and then we're good to go! Thanks again for your patience on this review!

@rtrieu rtrieu merged commit 2ebb612 into master Aug 12, 2025
19 checks passed
@rtrieu rtrieu deleted the rtrieu/docs-11542-java-servlet-based-web-apps branch August 12, 2025 14:23
StefonSimmons pushed a commit that referenced this pull request Aug 12, 2025
* [DOCS-11542] Java servlet support RUM

* add logo to partial

* remove config

* Apply suggestions from code review

Co-authored-by: Janine Chan <[email protected]>

* push changes

* Update content/en/real_user_monitoring/browser/setup/server/java.md

Co-authored-by: Janine Chan <[email protected]>

* update link

---------

Co-authored-by: Janine Chan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants